<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>api_shim.core.ssl_support</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;api_shim ::
        <a href="api_shim.core-module.html">Package&nbsp;core</a> ::
        Module&nbsp;ssl_support
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="api_shim.core.ssl_support-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="api_shim.core.ssl_support-module.html">Module api_shim.core.ssl_support</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">  1</tt>  <tt class="py-line"><tt class="py-comment"># Copyright 2011 the original author or authors.</tt> </tt>
<a name="L2"></a><tt class="py-lineno">  2</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L3"></a><tt class="py-lineno">  3</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Licensed under the Apache License, Version 2.0 (the "License");</tt> </tt>
<a name="L4"></a><tt class="py-lineno">  4</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># you may not use this file except in compliance with the License.</tt> </tt>
<a name="L5"></a><tt class="py-lineno">  5</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># You may obtain a copy of the License at</tt> </tt>
<a name="L6"></a><tt class="py-lineno">  6</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L7"></a><tt class="py-lineno">  7</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#      http://www.apache.org/licenses/LICENSE-2.0</tt> </tt>
<a name="L8"></a><tt class="py-lineno">  8</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L9"></a><tt class="py-lineno">  9</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Unless required by applicable law or agreed to in writing, software</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># distributed under the License is distributed on an "AS IS" BASIS,</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># See the License for the specific language governing permissions and</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># limitations under the License.</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt>  <tt class="py-line"><tt class="py-name">__author__</tt> <tt class="py-op">=</tt> <tt class="py-docstring">"Scott Horn"</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt>  <tt class="py-line"><tt id="link-0" class="py-name" targets="Variable api_shim.core.buffer.__email__=api_shim.core.buffer-module.html#__email__,Variable api_shim.core.event_bus.__email__=api_shim.core.event_bus-module.html#__email__,Variable api_shim.core.file_system.__email__=api_shim.core.file_system-module.html#__email__,Variable api_shim.core.handlers.__email__=api_shim.core.handlers-module.html#__email__,Variable api_shim.core.http.__email__=api_shim.core.http-module.html#__email__,Variable api_shim.core.javautils.__email__=api_shim.core.javautils-module.html#__email__,Variable api_shim.core.net.__email__=api_shim.core.net-module.html#__email__,Variable api_shim.core.parsetools.__email__=api_shim.core.parsetools-module.html#__email__,Variable api_shim.core.shared_data.__email__=api_shim.core.shared_data-module.html#__email__,Variable api_shim.core.sock_js.__email__=api_shim.core.sock_js-module.html#__email__,Variable api_shim.core.ssl_support.__email__=api_shim.core.ssl_support-module.html#__email__,Variable api_shim.core.streams.__email__=api_shim.core.streams-module.html#__email__,Variable api_shim.core.tcp_support.__email__=api_shim.core.tcp_support-module.html#__email__,Variable api_shim.vertx.__email__=api_shim.vertx-module.html#__email__"><a title="api_shim.core.buffer.__email__
api_shim.core.event_bus.__email__
api_shim.core.file_system.__email__
api_shim.core.handlers.__email__
api_shim.core.http.__email__
api_shim.core.javautils.__email__
api_shim.core.net.__email__
api_shim.core.parsetools.__email__
api_shim.core.shared_data.__email__
api_shim.core.sock_js.__email__
api_shim.core.ssl_support.__email__
api_shim.core.streams.__email__
api_shim.core.tcp_support.__email__
api_shim.vertx.__email__" class="py-name" href="#" onclick="return doclink('link-0', '__email__', 'link-0');">__email__</a></tt> <tt class="py-op">=</tt> <tt class="py-string">"scott@hornmicro.com"</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt>  <tt class="py-line"><tt id="link-1" class="py-name" targets="Variable api_shim.core.buffer.__credits__=api_shim.core.buffer-module.html#__credits__,Variable api_shim.core.event_bus.__credits__=api_shim.core.event_bus-module.html#__credits__,Variable api_shim.core.file_system.__credits__=api_shim.core.file_system-module.html#__credits__,Variable api_shim.core.handlers.__credits__=api_shim.core.handlers-module.html#__credits__,Variable api_shim.core.http.__credits__=api_shim.core.http-module.html#__credits__,Variable api_shim.core.javautils.__credits__=api_shim.core.javautils-module.html#__credits__,Variable api_shim.core.net.__credits__=api_shim.core.net-module.html#__credits__,Variable api_shim.core.parsetools.__credits__=api_shim.core.parsetools-module.html#__credits__,Variable api_shim.core.shared_data.__credits__=api_shim.core.shared_data-module.html#__credits__,Variable api_shim.core.sock_js.__credits__=api_shim.core.sock_js-module.html#__credits__,Variable api_shim.core.ssl_support.__credits__=api_shim.core.ssl_support-module.html#__credits__,Variable api_shim.core.streams.__credits__=api_shim.core.streams-module.html#__credits__,Variable api_shim.core.tcp_support.__credits__=api_shim.core.tcp_support-module.html#__credits__,Variable api_shim.vertx.__credits__=api_shim.vertx-module.html#__credits__"><a title="api_shim.core.buffer.__credits__
api_shim.core.event_bus.__credits__
api_shim.core.file_system.__credits__
api_shim.core.handlers.__credits__
api_shim.core.http.__credits__
api_shim.core.javautils.__credits__
api_shim.core.net.__credits__
api_shim.core.parsetools.__credits__
api_shim.core.shared_data.__credits__
api_shim.core.sock_js.__credits__
api_shim.core.ssl_support.__credits__
api_shim.core.streams.__credits__
api_shim.core.tcp_support.__credits__
api_shim.vertx.__credits__" class="py-name" href="#" onclick="return doclink('link-1', '__credits__', 'link-1');">__credits__</a></tt> <tt class="py-op">=</tt> <tt class="py-string">"Based entirely on work by Tim Fox http://tfox.org"</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"> </tt>
<a name="SSLSupport"></a><div id="SSLSupport-def"><a name="L19"></a><tt class="py-lineno"> 19</tt> <a class="py-toggle" href="#" id="SSLSupport-toggle" onclick="return toggle('SSLSupport');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="api_shim.core.ssl_support.SSLSupport-class.html">SSLSupport</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SSLSupport-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="SSLSupport-expanded"><a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line">  <tt class="py-docstring">""" A mixin module allowing SSL attributes to be set on classes """</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line">   </tt>
<a name="SSLSupport.set_ssl"></a><div id="SSLSupport.set_ssl-def"><a name="L22"></a><tt class="py-lineno"> 22</tt> <a class="py-toggle" href="#" id="SSLSupport.set_ssl-toggle" onclick="return toggle('SSLSupport.set_ssl');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="api_shim.core.ssl_support.SSLSupport-class.html#set_ssl">set_ssl</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">val</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SSLSupport.set_ssl-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="SSLSupport.set_ssl-expanded"><a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line">    <tt class="py-docstring">""" Set whether the server or client will use SSL.</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line"><tt class="py-docstring">    Keyword arguments:</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line"><tt class="py-docstring">    @param val: If true then ssl will be used.</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line"><tt class="py-docstring">    return self. So multiple invocations can be chained.</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">java_obj</tt><tt class="py-op">.</tt><tt class="py-name">setSSL</tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">)</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">self</tt> </tt>
</div><a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line"> </tt>
<a name="SSLSupport.get_ssl"></a><div id="SSLSupport.get_ssl-def"><a name="L33"></a><tt class="py-lineno"> 33</tt> <a class="py-toggle" href="#" id="SSLSupport.get_ssl-toggle" onclick="return toggle('SSLSupport.get_ssl');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="api_shim.core.ssl_support.SSLSupport-class.html#get_ssl">get_ssl</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SSLSupport.get_ssl-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="SSLSupport.get_ssl-expanded"><a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">java_obj</tt><tt class="py-op">.</tt><tt class="py-name">getSSL</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">self</tt> </tt>
</div><a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line">  <tt id="link-2" class="py-name" targets="Variable api_shim.core.ssl_support.SSLSupport.ssl=api_shim.core.ssl_support.SSLSupport-class.html#ssl"><a title="api_shim.core.ssl_support.SSLSupport.ssl" class="py-name" href="#" onclick="return doclink('link-2', 'ssl', 'link-2');">ssl</a></tt> <tt class="py-op">=</tt> <tt class="py-name">property</tt><tt class="py-op">(</tt><tt id="link-3" class="py-name" targets="Method api_shim.core.ssl_support.SSLSupport.get_ssl()=api_shim.core.ssl_support.SSLSupport-class.html#get_ssl"><a title="api_shim.core.ssl_support.SSLSupport.get_ssl" class="py-name" href="#" onclick="return doclink('link-3', 'get_ssl', 'link-3');">get_ssl</a></tt><tt class="py-op">,</tt> <tt id="link-4" class="py-name" targets="Method api_shim.core.ssl_support.SSLSupport.set_ssl()=api_shim.core.ssl_support.SSLSupport-class.html#set_ssl"><a title="api_shim.core.ssl_support.SSLSupport.set_ssl" class="py-name" href="#" onclick="return doclink('link-4', 'set_ssl', 'link-4');">set_ssl</a></tt><tt class="py-op">)</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line"> </tt>
<a name="SSLSupport.set_key_store_path"></a><div id="SSLSupport.set_key_store_path-def"><a name="L38"></a><tt class="py-lineno"> 38</tt> <a class="py-toggle" href="#" id="SSLSupport.set_key_store_path-toggle" onclick="return toggle('SSLSupport.set_key_store_path');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="api_shim.core.ssl_support.SSLSupport-class.html#set_key_store_path">set_key_store_path</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SSLSupport.set_key_store_path-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="SSLSupport.set_key_store_path-expanded"><a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line">    <tt class="py-docstring">"""Set the path to the SSL key store. This method should only be used with the client/server in SSL mode, i.e. after {#ssl=}</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line"><tt class="py-docstring">    has been set to true.</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line"><tt class="py-docstring">    The SSL key store is a standard Java Key Store, and should contain the client/server certificate. For a client, it's only necessary to supply</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line"><tt class="py-docstring">    a client key store if the server requires client authentication via client certificates.</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line"><tt class="py-docstring">    Keyword arguments:</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line"><tt class="py-docstring">    @param path: The path to the key store</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line"><tt class="py-docstring">    return self. So multiple invocations can be chained.</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">java_obj</tt><tt class="py-op">.</tt><tt class="py-name">setKeyStorePath</tt><tt class="py-op">(</tt><tt id="link-5" class="py-name" targets="Method api_shim.core.http.HttpServerRequest.path()=api_shim.core.http.HttpServerRequest-class.html#path,Method api_shim.core.http.ServerWebSocket.path()=api_shim.core.http.ServerWebSocket-class.html#path"><a title="api_shim.core.http.HttpServerRequest.path
api_shim.core.http.ServerWebSocket.path" class="py-name" href="#" onclick="return doclink('link-5', 'path', 'link-5');">path</a></tt><tt class="py-op">)</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">self</tt> </tt>
</div><a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line"> </tt>
<a name="SSLSupport.get_key_store_path"></a><div id="SSLSupport.get_key_store_path-def"><a name="L52"></a><tt class="py-lineno"> 52</tt> <a class="py-toggle" href="#" id="SSLSupport.get_key_store_path-toggle" onclick="return toggle('SSLSupport.get_key_store_path');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="api_shim.core.ssl_support.SSLSupport-class.html#get_key_store_path">get_key_store_path</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SSLSupport.get_key_store_path-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="SSLSupport.get_key_store_path-expanded"><a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">java_obj</tt><tt class="py-op">.</tt><tt class="py-name">getKeyStorePath</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line"> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line">  <tt id="link-6" class="py-name" targets="Variable api_shim.core.ssl_support.SSLSupport.key_store_path=api_shim.core.ssl_support.SSLSupport-class.html#key_store_path"><a title="api_shim.core.ssl_support.SSLSupport.key_store_path" class="py-name" href="#" onclick="return doclink('link-6', 'key_store_path', 'link-6');">key_store_path</a></tt> <tt class="py-op">=</tt> <tt class="py-name">property</tt><tt class="py-op">(</tt><tt id="link-7" class="py-name" targets="Method api_shim.core.ssl_support.SSLSupport.get_key_store_path()=api_shim.core.ssl_support.SSLSupport-class.html#get_key_store_path"><a title="api_shim.core.ssl_support.SSLSupport.get_key_store_path" class="py-name" href="#" onclick="return doclink('link-7', 'get_key_store_path', 'link-7');">get_key_store_path</a></tt><tt class="py-op">,</tt> <tt id="link-8" class="py-name" targets="Method api_shim.core.ssl_support.SSLSupport.set_key_store_path()=api_shim.core.ssl_support.SSLSupport-class.html#set_key_store_path"><a title="api_shim.core.ssl_support.SSLSupport.set_key_store_path" class="py-name" href="#" onclick="return doclink('link-8', 'set_key_store_path', 'link-8');">set_key_store_path</a></tt><tt class="py-op">)</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line"> </tt>
<a name="SSLSupport.set_key_store_password"></a><div id="SSLSupport.set_key_store_password-def"><a name="L57"></a><tt class="py-lineno"> 57</tt> <a class="py-toggle" href="#" id="SSLSupport.set_key_store_password-toggle" onclick="return toggle('SSLSupport.set_key_store_password');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="api_shim.core.ssl_support.SSLSupport-class.html#set_key_store_password">set_key_store_password</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">password</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SSLSupport.set_key_store_password-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="SSLSupport.set_key_store_password-expanded"><a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line">    <tt class="py-docstring">"""Set the password for the SSL key store. This method should only be used with the client in SSL mode, i.e. after ssl</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line"><tt class="py-docstring">    has been set to true.</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line"><tt class="py-docstring">    Keyword arguments:</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line"><tt class="py-docstring">    @param password: The password.</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line"><tt class="py-docstring">    return self. So multiple invocations can be chained.</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">java_obj</tt><tt class="py-op">.</tt><tt class="py-name">setKeyStorePassword</tt><tt class="py-op">(</tt><tt class="py-name">password</tt><tt class="py-op">)</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">self</tt> </tt>
</div><a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line"> </tt>
<a name="SSLSupport.get_key_store_password"></a><div id="SSLSupport.get_key_store_password-def"><a name="L69"></a><tt class="py-lineno"> 69</tt> <a class="py-toggle" href="#" id="SSLSupport.get_key_store_password-toggle" onclick="return toggle('SSLSupport.get_key_store_password');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="api_shim.core.ssl_support.SSLSupport-class.html#get_key_store_password">get_key_store_password</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SSLSupport.get_key_store_password-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="SSLSupport.get_key_store_password-expanded"><a name="L70"></a><tt class="py-lineno"> 70</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">java_obj</tt><tt class="py-op">.</tt><tt class="py-name">getKeyStorePassword</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line"> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line">  <tt id="link-9" class="py-name" targets="Variable api_shim.core.ssl_support.SSLSupport.key_store_password=api_shim.core.ssl_support.SSLSupport-class.html#key_store_password"><a title="api_shim.core.ssl_support.SSLSupport.key_store_password" class="py-name" href="#" onclick="return doclink('link-9', 'key_store_password', 'link-9');">key_store_password</a></tt> <tt class="py-op">=</tt> <tt class="py-name">property</tt><tt class="py-op">(</tt><tt id="link-10" class="py-name" targets="Method api_shim.core.ssl_support.SSLSupport.get_key_store_password()=api_shim.core.ssl_support.SSLSupport-class.html#get_key_store_password"><a title="api_shim.core.ssl_support.SSLSupport.get_key_store_password" class="py-name" href="#" onclick="return doclink('link-10', 'get_key_store_password', 'link-10');">get_key_store_password</a></tt><tt class="py-op">,</tt> <tt id="link-11" class="py-name" targets="Method api_shim.core.ssl_support.SSLSupport.set_key_store_password()=api_shim.core.ssl_support.SSLSupport-class.html#set_key_store_password"><a title="api_shim.core.ssl_support.SSLSupport.set_key_store_password" class="py-name" href="#" onclick="return doclink('link-11', 'set_key_store_password', 'link-11');">set_key_store_password</a></tt><tt class="py-op">)</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line"> </tt>
<a name="SSLSupport.set_trust_store_path"></a><div id="SSLSupport.set_trust_store_path-def"><a name="L74"></a><tt class="py-lineno"> 74</tt> <a class="py-toggle" href="#" id="SSLSupport.set_trust_store_path-toggle" onclick="return toggle('SSLSupport.set_trust_store_path');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="api_shim.core.ssl_support.SSLSupport-class.html#set_trust_store_path">set_trust_store_path</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SSLSupport.set_trust_store_path-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="SSLSupport.set_trust_store_path-expanded"><a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line">    <tt class="py-docstring">"""Set the path to the SSL trust store. This method should only be used with the client/server in SSL mode, i.e. after {#ssl=}</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line"><tt class="py-docstring">    has been set to true.</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt>  <tt class="py-line"><tt class="py-docstring">    The SSL trust store is a standard Java Key Store, and should contain the certificate(s) of the clients/servers that the server/client trusts. The SSL</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt>  <tt class="py-line"><tt class="py-docstring">    handshake will fail if the server provides a certificate that the client does not trust, or if client authentication is used,</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line"><tt class="py-docstring">    if the client provides a certificate the server does not trust.</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line"><tt class="py-docstring">    Keyword arguments:</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line"><tt class="py-docstring">    @param path: The path to the trust store</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt>  <tt class="py-line"><tt class="py-docstring">    return self. So multiple invocations can be chained.</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">java_obj</tt><tt class="py-op">.</tt><tt class="py-name">setTrustStorePath</tt><tt class="py-op">(</tt><tt id="link-12" class="py-name"><a title="api_shim.core.http.HttpServerRequest.path
api_shim.core.http.ServerWebSocket.path" class="py-name" href="#" onclick="return doclink('link-12', 'path', 'link-5');">path</a></tt><tt class="py-op">)</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">self</tt> </tt>
</div><a name="L88"></a><tt class="py-lineno"> 88</tt>  <tt class="py-line"> </tt>
<a name="SSLSupport.get_trust_store_path"></a><div id="SSLSupport.get_trust_store_path-def"><a name="L89"></a><tt class="py-lineno"> 89</tt> <a class="py-toggle" href="#" id="SSLSupport.get_trust_store_path-toggle" onclick="return toggle('SSLSupport.get_trust_store_path');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="api_shim.core.ssl_support.SSLSupport-class.html#get_trust_store_path">get_trust_store_path</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SSLSupport.get_trust_store_path-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="SSLSupport.get_trust_store_path-expanded"><a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">java_obj</tt><tt class="py-op">.</tt><tt class="py-name">getTrustStorePath</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L91"></a><tt class="py-lineno"> 91</tt>  <tt class="py-line"> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt>  <tt class="py-line">  <tt id="link-13" class="py-name" targets="Variable api_shim.core.ssl_support.SSLSupport.trust_store_path=api_shim.core.ssl_support.SSLSupport-class.html#trust_store_path"><a title="api_shim.core.ssl_support.SSLSupport.trust_store_path" class="py-name" href="#" onclick="return doclink('link-13', 'trust_store_path', 'link-13');">trust_store_path</a></tt> <tt class="py-op">=</tt> <tt class="py-name">property</tt><tt class="py-op">(</tt><tt id="link-14" class="py-name" targets="Method api_shim.core.ssl_support.SSLSupport.get_trust_store_path()=api_shim.core.ssl_support.SSLSupport-class.html#get_trust_store_path"><a title="api_shim.core.ssl_support.SSLSupport.get_trust_store_path" class="py-name" href="#" onclick="return doclink('link-14', 'get_trust_store_path', 'link-14');">get_trust_store_path</a></tt><tt class="py-op">,</tt> <tt id="link-15" class="py-name" targets="Method api_shim.core.ssl_support.SSLSupport.set_trust_store_path()=api_shim.core.ssl_support.SSLSupport-class.html#set_trust_store_path"><a title="api_shim.core.ssl_support.SSLSupport.set_trust_store_path" class="py-name" href="#" onclick="return doclink('link-15', 'set_trust_store_path', 'link-15');">set_trust_store_path</a></tt><tt class="py-op">)</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line"> </tt>
<a name="SSLSupport.set_trust_store_password"></a><div id="SSLSupport.set_trust_store_password-def"><a name="L94"></a><tt class="py-lineno"> 94</tt> <a class="py-toggle" href="#" id="SSLSupport.set_trust_store_password-toggle" onclick="return toggle('SSLSupport.set_trust_store_password');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="api_shim.core.ssl_support.SSLSupport-class.html#set_trust_store_password">set_trust_store_password</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">password</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SSLSupport.set_trust_store_password-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="SSLSupport.set_trust_store_password-expanded"><a name="L95"></a><tt class="py-lineno"> 95</tt>  <tt class="py-line">    <tt class="py-docstring">"""Set the password for the SSL trust store. This method should only be used with the client in SSL mode, i.e. after {#ssl=}</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line"><tt class="py-docstring">    has been set to true.</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line"><tt class="py-docstring">    Keyword arguments:</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line"><tt class="py-docstring">    @param password: The password.</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt>  <tt class="py-line"><tt class="py-docstring">     </tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line"><tt class="py-docstring">    return self. So multiple invocations can be chained.</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">java_obj</tt><tt class="py-op">.</tt><tt class="py-name">setTrustStorePassword</tt><tt class="py-op">(</tt><tt class="py-name">password</tt><tt class="py-op">)</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">self</tt> </tt>
</div><a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line"> </tt>
<a name="SSLSupport.get_trust_store_password"></a><div id="SSLSupport.get_trust_store_password-def"><a name="L106"></a><tt class="py-lineno">106</tt> <a class="py-toggle" href="#" id="SSLSupport.get_trust_store_password-toggle" onclick="return toggle('SSLSupport.get_trust_store_password');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="api_shim.core.ssl_support.SSLSupport-class.html#get_trust_store_password">get_trust_store_password</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SSLSupport.get_trust_store_password-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="SSLSupport.get_trust_store_password-expanded"><a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">java_obj</tt><tt class="py-op">.</tt><tt class="py-name">getTrustStorePassword</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L108"></a><tt class="py-lineno">108</tt>  <tt class="py-line"> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line">  <tt id="link-16" class="py-name" targets="Variable api_shim.core.ssl_support.SSLSupport.trust_store_password=api_shim.core.ssl_support.SSLSupport-class.html#trust_store_password"><a title="api_shim.core.ssl_support.SSLSupport.trust_store_password" class="py-name" href="#" onclick="return doclink('link-16', 'trust_store_password', 'link-16');">trust_store_password</a></tt> <tt class="py-op">=</tt> <tt class="py-name">property</tt><tt class="py-op">(</tt><tt id="link-17" class="py-name" targets="Method api_shim.core.ssl_support.SSLSupport.get_trust_store_password()=api_shim.core.ssl_support.SSLSupport-class.html#get_trust_store_password"><a title="api_shim.core.ssl_support.SSLSupport.get_trust_store_password" class="py-name" href="#" onclick="return doclink('link-17', 'get_trust_store_password', 'link-17');">get_trust_store_password</a></tt><tt class="py-op">,</tt> <tt id="link-18" class="py-name" targets="Method api_shim.core.ssl_support.SSLSupport.set_trust_store_password()=api_shim.core.ssl_support.SSLSupport-class.html#set_trust_store_password"><a title="api_shim.core.ssl_support.SSLSupport.set_trust_store_password" class="py-name" href="#" onclick="return doclink('link-18', 'set_trust_store_password', 'link-18');">set_trust_store_password</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L110"></a><tt class="py-lineno">110</tt>  <tt class="py-line"> </tt>
<a name="ClientSSLSupport"></a><div id="ClientSSLSupport-def"><a name="L111"></a><tt class="py-lineno">111</tt> <a class="py-toggle" href="#" id="ClientSSLSupport-toggle" onclick="return toggle('ClientSSLSupport');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="api_shim.core.ssl_support.ClientSSLSupport-class.html">ClientSSLSupport</a><tt class="py-op">(</tt><tt class="py-base-class">SSLSupport</tt><tt class="py-op">,</tt> <tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ClientSSLSupport-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ClientSSLSupport-expanded"><a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line"> </tt>
<a name="ClientSSLSupport.set_trust_all"></a><div id="ClientSSLSupport.set_trust_all-def"><a name="L113"></a><tt class="py-lineno">113</tt> <a class="py-toggle" href="#" id="ClientSSLSupport.set_trust_all-toggle" onclick="return toggle('ClientSSLSupport.set_trust_all');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="api_shim.core.ssl_support.ClientSSLSupport-class.html#set_trust_all">set_trust_all</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">val</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ClientSSLSupport.set_trust_all-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ClientSSLSupport.set_trust_all-expanded"><a name="L114"></a><tt class="py-lineno">114</tt>  <tt class="py-line">    <tt class="py-docstring">"""Should the client trust ALL server certificates?</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt>  <tt class="py-line"><tt class="py-docstring">    Keyword arguments:</tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt>  <tt class="py-line"><tt class="py-docstring">    @param val: If val is set to true then the client will trust ALL server certificates and will not attempt to authenticate them</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt>  <tt class="py-line"><tt class="py-docstring">    against it's local client trust store. The default value is false.</tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line"><tt class="py-docstring">    Use this method with caution!</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">java_obj</tt><tt class="py-op">.</tt><tt class="py-name">setTrustAll</tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">)</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">self</tt> </tt>
</div><a name="L123"></a><tt class="py-lineno">123</tt>  <tt class="py-line"> </tt>
<a name="ClientSSLSupport.get_trust_all"></a><div id="ClientSSLSupport.get_trust_all-def"><a name="L124"></a><tt class="py-lineno">124</tt> <a class="py-toggle" href="#" id="ClientSSLSupport.get_trust_all-toggle" onclick="return toggle('ClientSSLSupport.get_trust_all');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="api_shim.core.ssl_support.ClientSSLSupport-class.html#get_trust_all">get_trust_all</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ClientSSLSupport.get_trust_all-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ClientSSLSupport.get_trust_all-expanded"><a name="L125"></a><tt class="py-lineno">125</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">java_obj</tt><tt class="py-op">.</tt><tt class="py-name">getTrustAll</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L126"></a><tt class="py-lineno">126</tt>  <tt class="py-line"> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt>  <tt class="py-line">  <tt id="link-19" class="py-name" targets="Variable api_shim.core.ssl_support.ClientSSLSupport.trust_all=api_shim.core.ssl_support.ClientSSLSupport-class.html#trust_all"><a title="api_shim.core.ssl_support.ClientSSLSupport.trust_all" class="py-name" href="#" onclick="return doclink('link-19', 'trust_all', 'link-19');">trust_all</a></tt> <tt class="py-op">=</tt> <tt class="py-name">property</tt><tt class="py-op">(</tt><tt id="link-20" class="py-name" targets="Method api_shim.core.ssl_support.ClientSSLSupport.get_trust_all()=api_shim.core.ssl_support.ClientSSLSupport-class.html#get_trust_all"><a title="api_shim.core.ssl_support.ClientSSLSupport.get_trust_all" class="py-name" href="#" onclick="return doclink('link-20', 'get_trust_all', 'link-20');">get_trust_all</a></tt><tt class="py-op">,</tt> <tt id="link-21" class="py-name" targets="Method api_shim.core.ssl_support.ClientSSLSupport.set_trust_all()=api_shim.core.ssl_support.ClientSSLSupport-class.html#set_trust_all"><a title="api_shim.core.ssl_support.ClientSSLSupport.set_trust_all" class="py-name" href="#" onclick="return doclink('link-21', 'set_trust_all', 'link-21');">set_trust_all</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L128"></a><tt class="py-lineno">128</tt>  <tt class="py-line"> </tt>
<a name="ServerSSLSupport"></a><div id="ServerSSLSupport-def"><a name="L129"></a><tt class="py-lineno">129</tt> <a class="py-toggle" href="#" id="ServerSSLSupport-toggle" onclick="return toggle('ServerSSLSupport');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="api_shim.core.ssl_support.ServerSSLSupport-class.html">ServerSSLSupport</a><tt class="py-op">(</tt><tt class="py-base-class">SSLSupport</tt><tt class="py-op">,</tt> <tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerSSLSupport-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ServerSSLSupport-expanded"><a name="L130"></a><tt class="py-lineno">130</tt>  <tt class="py-line"> </tt>
<a name="ServerSSLSupport.set_client_auth_required"></a><div id="ServerSSLSupport.set_client_auth_required-def"><a name="L131"></a><tt class="py-lineno">131</tt> <a class="py-toggle" href="#" id="ServerSSLSupport.set_client_auth_required-toggle" onclick="return toggle('ServerSSLSupport.set_client_auth_required');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="api_shim.core.ssl_support.ServerSSLSupport-class.html#set_client_auth_required">set_client_auth_required</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">val</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerSSLSupport.set_client_auth_required-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ServerSSLSupport.set_client_auth_required-expanded"><a name="L132"></a><tt class="py-lineno">132</tt>  <tt class="py-line">    <tt class="py-docstring">""" Client authentication is an extra level of security in SSL, and requires clients to provide client certificates.</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt>  <tt class="py-line"><tt class="py-docstring">    Those certificates must be added to the server trust store.</tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L135"></a><tt class="py-lineno">135</tt>  <tt class="py-line"><tt class="py-docstring">    Keyword arguments:</tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt>  <tt class="py-line"><tt class="py-docstring">    @param val: If true then the server will request client authentication from any connecting clients, if they</tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt>  <tt class="py-line"><tt class="py-docstring">    do not authenticate then they will not make a connection.</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">java_obj</tt><tt class="py-op">.</tt><tt class="py-name">setClientAuthRequired</tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">)</tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">self</tt> </tt>
</div><a name="L142"></a><tt class="py-lineno">142</tt>  <tt class="py-line"> </tt>
<a name="ServerSSLSupport.get_client_auth_required"></a><div id="ServerSSLSupport.get_client_auth_required-def"><a name="L143"></a><tt class="py-lineno">143</tt> <a class="py-toggle" href="#" id="ServerSSLSupport.get_client_auth_required-toggle" onclick="return toggle('ServerSSLSupport.get_client_auth_required');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="api_shim.core.ssl_support.ServerSSLSupport-class.html#get_client_auth_required">get_client_auth_required</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerSSLSupport.get_client_auth_required-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ServerSSLSupport.get_client_auth_required-expanded"><a name="L144"></a><tt class="py-lineno">144</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">java_obj</tt><tt class="py-op">.</tt><tt class="py-name">getClientAuthRequired</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L145"></a><tt class="py-lineno">145</tt>  <tt class="py-line"> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt>  <tt class="py-line">  <tt id="link-22" class="py-name" targets="Variable api_shim.core.ssl_support.ServerSSLSupport.client_auth_required=api_shim.core.ssl_support.ServerSSLSupport-class.html#client_auth_required"><a title="api_shim.core.ssl_support.ServerSSLSupport.client_auth_required" class="py-name" href="#" onclick="return doclink('link-22', 'client_auth_required', 'link-22');">client_auth_required</a></tt> <tt class="py-op">=</tt> <tt class="py-name">property</tt><tt class="py-op">(</tt><tt id="link-23" class="py-name" targets="Method api_shim.core.ssl_support.ServerSSLSupport.get_client_auth_required()=api_shim.core.ssl_support.ServerSSLSupport-class.html#get_client_auth_required"><a title="api_shim.core.ssl_support.ServerSSLSupport.get_client_auth_required" class="py-name" href="#" onclick="return doclink('link-23', 'get_client_auth_required', 'link-23');">get_client_auth_required</a></tt><tt class="py-op">,</tt> <tt id="link-24" class="py-name" targets="Method api_shim.core.ssl_support.ServerSSLSupport.set_client_auth_required()=api_shim.core.ssl_support.ServerSSLSupport-class.html#set_client_auth_required"><a title="api_shim.core.ssl_support.ServerSSLSupport.set_client_auth_required" class="py-name" href="#" onclick="return doclink('link-24', 'set_client_auth_required', 'link-24');">set_client_auth_required</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L147"></a><tt class="py-lineno">147</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1
    on Wed Jul 17 20:25:00 2013
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>